OpenEdge Development:<br />Progress 4GL Reference SESSION system handle

A handle to the current OpenEdge session object. This object allows you to read and modify the current OpenEdge session context.

Syntax

Attributes

Methods

The following example uses the SESSION:IMMEDIATE-DISPLAY attribute. When dumping or loading records from the database, the procedure displays a running count of records. If IMMEDIATE-DISPLAY is false, no value is shown until all records are dumped or loaded. At that point, the total is shown. To prevent this, IMMEDIATE-DISPLAY is set to true just before the dump or load and then reset to false afterwards.

SESSION [ :`attribute` \| :`method` ]

APPL-ALERT-BOXES attribute	BASE-ADE attribute
BATCH-MODE attribute	CHARSET attribute
CLIENT-TYPE attribute	CONTEXT-HELP-FILE attribute
CPCASE attribute	CPCOLL attribute
CPINTERNAL attribute	CPLOG attribute
CPPRINT attribute	CPRCODEIN attribute
CPRCODEOUT attribute	CPSTREAM attribute
CPTERM attribute	DATA-ENTRY-RETURN attribute
DATE-FORMAT attribute	DEBUG-ALERT attribute
DISPLAY-TIMEZONE attribute	DISPLAY-TYPE attribute
FIRST-BUFFER attribute	FIRST-CHILD attribute
FIRST-DATASET attribute	FIRST-DATA-SOURCE attribute
FIRST-OBJECT attribute	FIRST-PROCEDURE attribute
FIRST-QUERY attribute	FIRST-SERVER attribute
FIRST-SERVER-SOCKET attribute	FIRST-SOCKET attribute
FRAME-SPACING attribute	HEIGHT-CHARS attribute
HEIGHT-PIXELS attribute	ICFPARAMETER attribute
IMMEDIATE-DISPLAY attribute	LAST-CHILD attribute
LAST-OBJECT attribute	LAST-PROCEDURE attribute
LAST-SERVER attribute	LAST-SERVER-SOCKET attribute
LAST-SOCKET attribute	MULTITASKING-INTERVAL attribute
NEXT-SIBLING attribute	NUMERIC-DECIMAL-POINT attribute
NUMERIC-FORMAT attribute	NUMERIC-SEPARATOR attribute
PARAMETER attribute	PIXELS-PER-COLUMN attribute
PIXELS-PER-ROW attribute	PRINTER-CONTROL-HANDLE attribute
PRINTER-HDC attribute	PRINTER-NAME attribute
PRINTER-PORT attribute	PROXY-PASSWORD attribute
PROXY-USERID attribute	REMOTE attribute
SCHEMA-CHANGE attribute	SERVER-CONNECTION-BOUND attribute
SERVER-CONNECTION-BOUND-REQUEST attribute	SERVER-CONNECTION-CONTEXT attribute
SERVER-CONNECTION-ID attribute	SERVER-OPERATING-MODE attribute
STARTUP-PARAMETERS attribute	STREAM attribute
SUPER-PROCEDURES attribute	SUPPRESS-WARNINGS attribute
SYSTEM-ALERT-BOXES attribute	TEMP-DIRECTORY attribute
THREE-D attribute	TIME-SOURCE attribute
TOOLTIPS attribute	TYPE attribute
V6DISPLAY attribute	WIDTH-CHARS attribute
WIDTH-PIXELS attribute	WINDOW-SYSTEM attribute
WORK-AREA-HEIGHT-PIXELS attribute	WORK-AREA-WIDTH-PIXELS attribute
WORK-AREA-X attribute	WORK-AREA-Y attribute
YEAR-OFFSET attribute

ADD-SUPER-PROCEDURE( ) method	EXPORT( ) method
GET-PRINTERS( ) method	GET-WAIT-STATE( ) method
REMOVE-SUPER-PROCEDURE( ) method	SET-NUMERIC-FORMAT( ) method
SET-WAIT-STATE( ) method

r-dstrig.p
DEFINE SUB-MENU file MENU-ITEM viewit LABEL "&View Data" MENU-ITEM dumpit LABEL "&Dump Data" MENU-ITEM loadit LABEL "&Load Data". MENU-ITEM exit LABEL "E&xit". DEFINE MENU mbar MENUBAR SUB-MENU file LABEL "&File". DEFINE BUTTON b_more LABEL "Next". DEFINE BUTTON b_exit LABEL "Cancel". DEFINE FRAME cust-frame customer.cust-num SKIP customer.name SKIP customer.phone SKIP b_more b_exit WITH CENTERED SIDE-LABELS ROW 3. DEFINE STREAM cust. DEFINE VARIABLE i AS INTEGER NO-UNDO. PAUSE 0 BEFORE-HIDE. ON CHOOSE OF b_exit IN FRAME cust-frame DO: HIDE FRAME cust-frame NO-PAUSE. DISABLE ALL WITH FRAME cust-frame. LEAVE. END. ON CHOOSE OF b_more IN FRAME cust-frame DO: FIND NEXT customer NO-LOCK NO-ERROR. IF NOT AVAILABLE(customer) THEN RETURN. DISPLAY customer.cust-num customer.name customer.phone WITH FRAME cust-frame. END.
ON CHOOSE OF MENU-ITEM viewit DO: ENABLE ALL WITH FRAME cust-frame. FIND FIRST customer NO-LOCK NO-ERROR. DISP customer.cust-num customer.name customer.phone WITH FRAME cust-frame. APPLY "ENTRY" TO b_more. END. ON CHOOSE OF MENU-ITEM dumpit DO: DISABLE TRIGGERS FOR DUMP OF customer. i = 1. SESSION:IMMEDIATE-DISPLAY = TRUE. OUTPUT STREAM cust TO "customer.d". FOR EACH customer NO-LOCK: EXPORT STREAM cust customer. DISP i LABEL "Records Processed" WITH FRAME rec-info SIDE-LABELS ROW SCREEN-LINES / 2 CENTERED. i = i + 1. END. SESSION:IMMEDIATE-DISPLAY = FALSE. OUTPUT STREAM cust CLOSE. END. ON CHOOSE OF MENU-ITEM loadit DO: DISABLE TRIGGERS FOR LOAD OF customer. INPUT FROM "customer.d". SESSION:IMMEDIATE-DISPLAY = TRUE. REPEAT: CREATE customer. IMPORT customer. DISP i LABEL "Records Processed" WITH FRAME rec-info SIDE-LABELS ROW SCREEN-LINES / 2 CENTERED. i = i + 1. END. INPUT CLOSE. SESSION:IMMEDIATE-DISPLAY = FALSE. END. IF NOT RETRY THEN ASSIGN CURRENT-WINDOW:MENUBAR = MENU mbar:HANDLE CURRENT-WINDOW:VISIBLE = TRUE. WAIT-FOR CHOOSE OF MENU-ITEM exit.

r-dstrig.p

DEFINE SUB-MENU file
  MENU-ITEM viewit LABEL "&View Data"
  MENU-ITEM dumpit LABEL "&Dump Data"
  MENU-ITEM loadit LABEL "&Load Data".
  MENU-ITEM exit   LABEL "E&xit".
  DEFINE MENU mbar MENUBAR
  SUB-MENU file LABEL "&File".
  DEFINE BUTTON b_more LABEL "Next".
DEFINE BUTTON b_exit LABEL "Cancel".
DEFINE FRAME cust-frame
  customer.cust-num SKIP
  customer.name  SKIP
  customer.phone SKIP
  b_more b_exit
  WITH CENTERED SIDE-LABELS ROW 3.
DEFINE STREAM cust.
DEFINE VARIABLE i AS INTEGER NO-UNDO.

PAUSE 0 BEFORE-HIDE.

ON CHOOSE OF b_exit IN FRAME cust-frame
DO:
  HIDE FRAME cust-frame NO-PAUSE.
  DISABLE ALL WITH FRAME cust-frame.
  LEAVE.
END.  

ON CHOOSE OF b_more IN FRAME cust-frame
DO:
  FIND NEXT customer NO-LOCK NO-ERROR.
  IF NOT AVAILABLE(customer) THEN
    RETURN.
  DISPLAY customer.cust-num customer.name customer.phone
    WITH FRAME cust-frame.
END.

ON CHOOSE OF MENU-ITEM viewit
DO:
  ENABLE ALL WITH FRAME cust-frame.
  FIND FIRST customer NO-LOCK NO-ERROR.
  DISP customer.cust-num customer.name customer.phone 
    WITH FRAME cust-frame.
  APPLY "ENTRY" TO b_more.
END.

ON CHOOSE OF MENU-ITEM dumpit
DO:
  DISABLE TRIGGERS FOR DUMP OF customer.
  i = 1.
  SESSION:IMMEDIATE-DISPLAY = TRUE.
  OUTPUT STREAM cust TO "customer.d".
  FOR EACH customer NO-LOCK:
    EXPORT STREAM cust customer.
    DISP i LABEL "Records Processed" 
      WITH FRAME rec-info SIDE-LABELS ROW SCREEN-LINES / 2 CENTERED.
    i = i + 1.
  END.
  SESSION:IMMEDIATE-DISPLAY = FALSE.
  OUTPUT STREAM cust CLOSE.
END.

ON CHOOSE OF MENU-ITEM loadit
DO:
  DISABLE TRIGGERS FOR LOAD OF customer.
  INPUT FROM "customer.d".
  SESSION:IMMEDIATE-DISPLAY = TRUE.
  REPEAT:
    CREATE customer.
    IMPORT customer.
    DISP i LABEL "Records Processed"
      WITH FRAME rec-info SIDE-LABELS ROW SCREEN-LINES / 2 CENTERED.
    i = i + 1.
  END.
  INPUT CLOSE.
  SESSION:IMMEDIATE-DISPLAY = FALSE.
END.

IF NOT RETRY THEN  
ASSIGN CURRENT-WINDOW:MENUBAR = MENU mbar:HANDLE
       CURRENT-WINDOW:VISIBLE = TRUE.
 
WAIT-FOR CHOOSE OF MENU-ITEM exit.

Notes

Several attributes of the SESSION handle control the execution of Progress code during the current OpenEdge session. This means that the SESSION handle controls the behavior of any code that you are developing and testing, and the OpenEdge ADE toolset. While the tools of the OpenEdge ADE monitor and set the attributes of the SESSION handle to meet their needs, it is possible that the execution of a procedure that sets attributes of the SESSION handle may affect the display and behavior of the OpenEdge ADE toolset.

The FIRST-PROCEDURE and LAST-PROCEDURE attributes are set or reset when you create or delete the first or last persistent procedure in a session. You can use procedure attributes to navigate the procedure entries, reference information, and manage the user interface for each persistent procedure in the procedure chain accessed by FIRST-PROCEDURE and LAST-PROCEDURE.

For more information on the attributes of procedure handles, see the THIS-PROCEDURE system handle reference entry. For information on creating a persistent procedure, see the RUN statement reference entry. For information on deleting a persistent procedure, see the DELETE PROCEDURE statement reference entry.

The FIRST-SERVER and LAST-SERVER attributes are set or reset when you create or delete the first or last server handle in a session. You can use server handle attributes and methods to navigate the current chain of server handles, connect to a running AppServer, reference information on a connected AppServer, access remote persistent procedures running on a connected AppServer, and disconnect from a connected AppServer for each server handle in the chain accessed by FIRST-SERVER and LAST-SERVER.

For more information on the attributes and methods of server handles, see the Server object handle reference entry. For information on creating server handles, see the CREATE SAX-READER statement reference entry.

Setting the IMMEDIATE-DISPLAY attribute to TRUE can significantly slow performance. However, some code segments may not execute properly with IMMEDIATE-DISPLAY set to FALSE. If a segment of code requires that IMMEDIATE-DISPLAY is TRUE, you should set the attribute to TRUE immediately before the code segment and change it back to FALSE immediately after the segment.

In Windows, when execution is blocked for input (by a WAIT-FOR statement, for example), Progress listens for messages from the windowing system. This allows Progress to multitask properly with other Windows applications. However, if your OpenEdge application performs long processing without blocking for input, then it may not multitask properly because Progress does not automatically check for messages from the windowing system. To force Progress to poll for windowing system messages during this time, you can set the MULTITASKING-INTERVAL attribute to a non-zero value. The lower the value, the more often Progress checks for messages. This may decrease Progress performance. The maximum value is 9999. A value of 0 inhibits polling until Progress blocks for input.

If you set MULTITASKING-INTERVAL to a non-zero value for a code segment, reset it to 0 immediately after that code.

Progress sets the TEMP-DIRECTORY attribute to the value you specify for the Temporary Directory (-T) parameter. If you omit the -T parameter, TEMP-DIRECTORY is set to your current working directory.

The TYPE attribute returns the widget type, PSEUDO-WIDGET.

Use the SET-WAIT-STATE method to prevent user and system input, and provide visual feedback during a long computation or other background process. The value you pass determines the type of wait message or cursor the windowing system displays for the user. Passing the value "" to SET-WAIT-STATE ends the wait state. Use this method only for long computations or other processes that force the user to wait significantly longer than the usual response time.

If you set a wait state for your application, Progress automatically ends the wait state if it displays an alert box, a dialog box, or message update.

For SpeedScript, the invalid attributes are: APPL-ALERT-BOXES, CONTEXT-HELP-FILE, DATA-ENTRY-RETURN, FIRST-CHILD, HEIGHT-PIXELS, LAST-CHILD, PARAMETER, PIXELS-PER-COLUMN, PIXELS-PER-ROW, SUPPRESS-WARNINGS, SYSTEM-ALERT-BOXES, THREE-D, TOOLTIPS, V6DISPLAY, WIDTH-PIXELS. The GET-PRINTERS( ) method is invalid for SpeedScript.